Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 1, 2024

remove HandWritten component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4591

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Remove the Handwritten component from the codebase and update references to use the BootstrapBlazor.SignaturePad component. Update documentation and localization files to reflect this change and remove associated unit tests.

Enhancements:

  • Deprecate the Handwritten component and recommend using the BootstrapBlazor.SignaturePad component instead.

Documentation:

  • Update documentation to reflect the deprecation of the Handwritten component and guide users to use the BootstrapBlazor.SignaturePad component.

Tests:

  • Remove unit tests related to the Handwritten component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 1, 2024

Reviewer's Guide by Sourcery

This PR removes the deprecated HandWritten component and replaces its demo page with a notice directing users to use BootstrapBlazor.SignaturePad instead. The implementation involves removing the component's test file and updating the demo page to show a deprecation message in both English and Chinese.

Class diagram for the removal of HandWritten component

classDiagram
    class Handwritten {
        <<deprecated>>
        +HandwrittenBase64
    }
    class SignaturePad {
        +SignaturePadBase64
    }
    Handwritten --|> SignaturePad : "Use instead"
    note for Handwritten "This component is deprecated and replaced by SignaturePad"
Loading

File-Level Changes

Change Details Files
Mark the Handwritten component as deprecated
  • Add Obsolete attribute with migration message
  • Add ExcludeFromCodeCoverage attribute
  • Update component documentation comment
src/BootstrapBlazor/Components/Handwritten/Handwritten.razor.cs
Update the Handwritten demo page to show deprecation notice
  • Remove the demo implementation
  • Replace demo with Tips component showing deprecation message
  • Update component description
src/BootstrapBlazor.Server/Components/Samples/Handwrittens.razor
src/BootstrapBlazor.Server/Components/Samples/Handwrittens.razor.cs
Add localization strings for deprecation notice
  • Add English deprecation message with link to new component
  • Add Chinese deprecation message with link to new component and known issues
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Remove component unit tests
  • Delete HandwrittenTest.cs file
test/UnitTest/Components/HandwrittenTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4591 Remove the HandWritten component

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Nov 1, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 1, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang enabled auto-merge (squash) November 1, 2024 11:35
@codecov
Copy link

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d302b88) to head (ecc4021).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4592   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          621       620    -1     
  Lines        27398     27382   -16     
  Branches      3921      3919    -2     
=========================================
- Hits         27398     27382   -16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 2f6350b into main Nov 1, 2024
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-hw branch November 1, 2024 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(HandWritten): remove HandWritten component

2 participants